/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.user;

import axil.api.AxilType;
import axil.api.Formatting;
import axil.api.Persona;
import axil.etc.Identity;
import axil.framework.format.SimpleFormatting;
import axil.framework.localization.Locality;
import axil.stdlib.core.type.Atom;

import java.util.TimeZone;

import static axil.framework.Functions.empty;


/**
 * The default Axil representation of a Persona. The host application is likely
 * to provide its own implementation.
 */
public class User implements Persona, Identity {
	private static final User system = new User("system", Locality.from("en_US"),
	        TimeZone.getDefault());

	private String ident;
	private Locality locale;
	private TimeZone timezone;


	public User(String ident, Locality locale, TimeZone timezone) {
		assert ! empty(ident);
		assert locale != null;
		assert timezone != null;

		this.ident = ident;
		this.locale = locale;
		this.timezone = timezone;
	}


	public static User system() {
		return system;
	}


	/**
	 * Get the unique identity for this object. The string returned is never
	 * empty and contains no punctuation characters beyond a possible '-'. The
	 * value is suitable for use as an identifier.
	 */
	public String identity() {
		return ident;
	}


	/**
	 * Get the locale for this persona. The object returned is never null.
	 */
	public Locality locale() {
		return locale;
	}


	/**
	 * Get the time zone associated with this persona.
	 *
	 * @return
	 * 	Returns a non-null time zone.
	 */
	public TimeZone timezone() {
		return timezone;
	}


	/**
	 * Get the formatting preferences for this persona.
	 *
	 * @param type
	 * 	The type of object to be formatted. The type given is never null.
	 *
	 * @return
	 * 	Returns the formatting preferences for this persona for the given type.
	 * 	The object returned may be null, in which case the preferences for the
	 * 	locale will be used.
	 */
	public Formatting formatting(AxilType type) {
		return type instanceof Atom ?
		       ((Atom)type).formatting(locale) :
		       SimpleFormatting.object;
	}


	/**
	 * Return a string representation of this object. The string returned is
	 * never null.
	 */
	public String toString() {
		return ident;
	}
}
